Repository navigation
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Hi @bezabyte! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
AI review status for this pull request.
|
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
There was a problem hiding this comment.
Changes requested: the showcase fix matches the direction from the earlier discussion. The evidence screenshots need to move out of the branch.
- Drop the commit that adds
docs/evidence/issue-2703/before.png,after.pngandcomparison.png, because the repository's evidence rule (architecture:knowledge-contractsINV22) keeps one-off screenshots on the pull request instead of in the repository.
Attach the three images to the pull request description instead, so the before and after evidence stays with this pull request after the fork branch is gone.
|
Addressed the evidence request.
|
There was a problem hiding this comment.
Approved pending CI: CI has not run on this head yet. Next step: a maintainer adds the ci:run label so CI runs.
The SideNav family showcases now sit in a full-height AppShell, following the direction from the earlier discussion, and the evidence screenshots have moved from the branch to the description, which resolves the earlier request. No blocking findings remain.
Claims and files checked
- Previews sit inside a full-size
AppShellinstead of a floating rail: verified in all five blocks (SideNavShowcase.tsx:123-168and the four sibling showcases). - The empty area under the rail is gone: verified from the source; the rail fills the shell's side region.
- The main SideNav showcase shows footer destinations: verified (
SideNavShowcase.tsx:130-142, Help & docs and Settings). - Only the five family showcases and their metadata change; the preview renderer and component behavior and API do not: verified from the changed-file list.
- The rail stays visible at narrow widths: verified;
breakpoint: 'none'never enters the mobile layout (AppShell.tsx:624-634). - The before and after captures use the same page and viewport: not checkable from the repository.
- The listed test commands pass: not verified in this review; CI has not run on this head.
- Public text and artifacts carry no internal context: verified over the title, description, branch, commits and added lines.
- The changeset is a CLI patch with a
[fix]category and a contributor line: verified againstCONTRIBUTING.md. - Files: all 11 clear (five
*Showcase.tsx, five*Showcase.doc.mjs, the changeset).
kentonquatman
left a comment
There was a problem hiding this comment.
Adding the footer is nice, but the white content area makes the showcase look broken. Could we update so that the change is only adding the footer?
|
I'll run a full review to re-check this with your note. |
There was a problem hiding this comment.
Changes requested: the design review on this head asks for a narrower change, so this review does not approve while that request is open.
- The empty white
AppShellcontent area makes the SideNav-family previews look broken (it fills about two-thirds of the SideNav, SideNavCollapseButton, SideNavItem and SideNavSection previews), so keep the new SideNav footer, drop theAppShellwrapper as the design review asks, and update the changeset and description to match.
Please confirm with the design reviewer how the four showcases without a footer should look, since the description closes #2703 for them too. CI has not run on this head yet.
Claims and files checked
- Previews sit inside a full-size
AppShellinstead of a floating rail: verified in all five showcases. - The empty area under the rail is gone: verified; an empty white content area now sits beside the rail, which is the design review's point.
- The main SideNav showcase shows footer destinations: verified (
SideNavShowcase.tsx:130-143). - Only the five showcases and their metadata change; the preview renderer and component behavior and API do not: verified from the changed files.
- The rail stays visible at narrow widths: verified;
breakpoint: 'none'never enters the mobile layout. - The before and after captures use the same page and viewport: not checkable from the repository.
- The template docs typecheck passes: verified once Core is built.
- The docsite data-extraction and example-coverage suites pass (141 tests): verified.
- The docsite preview-state and preview-theme suites pass (40 tests): verified.
- Full pre-commit checks and the pre-review checklist passed: not verified.
- Public text carries no internal context: verified over the title, description, branch, commits and added lines.
- The changeset is a CLI patch with a
[fix]category and a contributor line: verified againstCONTRIBUTING.md. - Files: the five
*Showcase.tsxcarry the finding above; the five*Showcase.doc.mjsare clear; the changeset is clear at this head and needs rewording with the rework.
|
Addressed the design review on
Verification: template-doc typecheck passed; docsite data extraction, example coverage, preview state, and preview theme suites passed (181 tests); targeted lint/formatting and repository pre-commit checks passed. The remaining question is the design owner's desired treatment for the four sibling previews. |
There was a problem hiding this comment.
Changes requested: the narrowed change is close to what the design review asked for, with two small fixes left.
- The title, "fix(docsite): contain SideNav family showcases", no longer matches the change, since only the SideNav showcase gains footer destinations, so please retitle it (for example "fix(docsite): add footer destinations to the SideNav showcase").
- Regression:
SideNavShowcase.doc.mjsstill setsaspectRatio: 16 / 9, which came with the removedAppShelllayout and makes the CLI's showcase response describe a narrow rail as a wide 16:9 showcase, so please restoreaspectRatio: 1.
The design owner's change request stays open until they re-review this head. The sentence "does not close #2703" in the description contains a GitHub closing keyword, so merging would close the issue; rewording it keeps the issue open as intended. CI has not run on this head yet.
Claims and files checked
- The SideNav preview shows help and settings destinations in its footer: verified.
- The four sibling previews keep their original presentation: verified.
- The
AppShellwrapper and its metadata are removed: the wrapper andAppShellentries are gone; theAppShell-era aspect ratio remains. - The preview renderer, component behavior and public API are unchanged: verified.
- The changeset describes only the footer addition: verified, with the patch bump, category and contributor line the contributing guide asks for.
- The template docs typecheck passes: verified once Core is built.
- The four docsite test suites pass (181 tests): verified.
- Targeted ESLint and Prettier pass: verified.
- Full pre-commit checks pass: not verified; CI has not run on this head.
- Public text carries no internal context: verified.
- The pull request leaves the issue open: false in effect, because of the closing keyword above.
- The title's family-wide containment: false.
- Files:
SideNavShowcase.doc.mjscarries the aspect-ratio finding;SideNavShowcase.tsxis clear apart from a non-blocking note that its two new icons could come from@heroicons/react; the changeset,SideNavHeadingShowcase.tsxand the other four.doc.mjsfiles are clear.
|
Addressed the remaining SideNav review findings in f69121a:
Verification: template-doc typecheck, targeted Prettier, diff check, and the repository pre-commit checks passed. The design review and ci:run remain maintainer gates. |
There was a problem hiding this comment.
Approved pending CI: CI has not run on this head yet. Next step: a maintainer adds the ci:run label so CI runs.
The SideNav showcase now ends its rail with Help & docs and Settings, the title and description match the change, and the showcase's aspectRatio is back to 1. Optional: @heroicons/react/24/outline already exports Cog6ToothIcon and LifebuoyIcon, so importing them would replace the two new inline SVG components in SideNavShowcase.tsx.
Claims and files checked
- The SideNav preview shows help and settings destinations in its footer: verified.
- The changeset describes only that footer addition, as a CLI patch with a category and contributor line: verified.
- The four sibling previews keep their original standalone presentation: verified.
- The showcase's square aspect ratio is restored: verified.
- The
AppShellwrapper and its metadata are gone: verified. - The preview renderer, component behavior and public API are unchanged: verified.
- The template docs typecheck passes: verified.
- The four docsite test suites pass (181 tests): verified.
- Targeted ESLint and Prettier pass: verified.
- The repository pre-commit checks pass: verified, apart from three steps that need a git working tree; this change touches no file mode, script or fixture they check.
- Public text carries no internal context: verified.
- The pull request leaves the issue open: verified; no closing keyword remains.
- Files:
SideNavShowcase.tsxcarries the optional icon note; the changeset,SideNavHeadingShowcase.tsxand the four.doc.mjsfiles are clear.
|
Optional cleanup from the latest approved review is also pushed in 57ac2f4: the SideNav showcase now reuses the repository's @heroicons/react outline icons for Help and Settings instead of carrying duplicate inline SVG definitions. Template-doc typecheck, targeted lint/formatting, and repository pre-commit checks pass. The PR is approved pending maintainer CI. |
There was a problem hiding this comment.
Approved pending CI: CI has not run on this head yet. Next step: a maintainer adds the ci:run label so CI runs.
The SideNav showcase now ends its rail with Help & docs and Settings, drawn with the outline icon library, and the three corrected componentsUsed lists match their blocks. Optional: HomeIcon, FolderIcon, ChartBarIcon and DocumentTextIcon in SideNavShowcase.tsx are the same artwork as @heroicons/react/24/outline's icons of those names, so importing them too would remove the block's last inline SVG; its doc also still lacks a description and lists only SideNav in componentsUsed.
Claims and files checked
- The SideNav preview shows help and settings destinations in its footer: verified.
- Help and Settings use the outline icon library instead of copied SVG paths: verified.
- The changeset describes only that footer addition, as a CLI patch with a category and contributor line: verified.
- The four sibling previews keep their original standalone presentation: verified.
- The showcase's square aspect ratio is restored: verified.
- The
AppShellwrapper and its metadata are gone: verified. - The preview renderer, component behavior and public API are unchanged: verified.
- The template docs typecheck passes: verified.
- The four docsite test suites pass (181 tests): verified.
- Targeted ESLint and Prettier pass: verified.
- The repository pre-commit checks pass: verified, apart from three steps that need a git working tree; this change touches no file mode, script, manifest or fixture they check.
- Public text carries no internal context: verified.
- The change is design-approved: verified for an earlier revision; the later commits restore the aspect ratio and switch the footer icons to the library's, which redraws the Help icon.
- The pull request leaves the issue open: verified; no closing keyword remains.
- Files:
SideNavShowcase.tsxcarries the optional icon and doc note; the changeset,SideNavHeadingShowcase.tsxand the four.doc.mjsfiles are clear.
Review mode: full — reason: author-not-engowner
|
/approve-spec 57ac2f4 |
…sign/template-icons
There was a problem hiding this comment.
Changes requested: the footer itself looks right, but this branch lacks a package its new import needs, and the description is out of date.
SideNavShowcase.tsx:6importsHelpIconandSettingsIconfrom@astryxdesign/template-icons, which reachedmainafter this branch was cut, so at this head the template fails to typecheck (TS2307) and the docsite data step fails on this block, which is why the preview deployment failed; mergingmaininto the branch fixes it with no code change.- Regression: the description says issue #2703 remains open, but #12648 closed it on 2026-11-19 by centering the SideNav previews on
main, so please update that line along with the preview and testing notes once the merge is in.
Merged into main, the change typechecks, passes the template icon and docsite tests, and renders the Support group under Documents with a question-mark Help icon.
Claims and files checked
Review mode: full; reason: author-not-engowner
- The SideNav Overview preview shows support and settings destinations in its footer: verified once merged into
main; at this head the block does not build. - The four sibling previews keep their standalone presentation: verified; their blocks change only in metadata, one comment and import order.
- The Support footer stays only in the SideNav showcase: verified.
- Help and Settings reuse the repository's outline icons instead of duplicated SVG paths: verified against the template icon package on
main; the package is not on this branch. - The square aspect ratio is restored: verified; the SideNav doc keeps
aspectRatio: 1. - The AppShell wrapper and its metadata are gone from the five showcases: verified.
- The preview renderer, SideNav behavior and public API are unchanged: verified.
- The changeset describes only the footer addition: verified.
- The design reviewer can verify both states in the generated preview: false at this head; the docsite build fails.
- The template-doc typecheck passes: verified; the stricter template typecheck fails at this head.
- The four docsite test files pass: false at this head, where data extraction fails; they pass once merged.
- Targeted ESLint and Prettier pass: verified.
- The full pre-commit checks pass: not reproduced in full; its lint and format steps pass.
- No component behavior or public API changes: verified.
- Public text carries no internal context: verified.
- The pull request is design-approved: verified for an earlier revision; the Help icon has changed since.
- Issue #2703 remains open: false; it was closed on 2026-11-19.
- Files:
SideNavShowcase.tsx(blocking import, plus a non-blocking template-quality note); the changeset,SideNavHeadingShowcase.tsxand the four doc files are clear.
There was a problem hiding this comment.
Changes requested: the code is ready, and one line of the description needs an update.
- Regression: the description's last line says issue #2703 remains open, but #2703 was closed as completed on 2026-11-19 by a separate fix on
main, so please update that line and describe this change as the footer addition on top of that fix.
Merging main fixed the earlier missing @astryxdesign/template-icons failure: at this head the block typechecks, the docs site builds it, and a copy fills both icons from Heroicons. CI has not run on this head yet; its workflow runs are waiting for a maintainer to approve them. An optional icon cleanup is noted inline.
Claims and files checked
Review mode: full; reason: author-not-engowner
- Claims:
- Changeset: the SideNav showcase's footer now has support and settings destinations — verified (
SideNavShowcase.tsx:86-91). - The Support footer is added only to the SideNav showcase — verified (the four sibling sources render as on
main). - The Help and Settings icons come by meaning from the template icon package, and the branch is merged with
main, which ships it — verified (SideNavShowcase.tsx:6; the head mergesmain; a copy importsQuestionMarkCircleIconandCog6ToothIcon). - The showcase keeps its square aspect ratio — verified (
SideNavShowcase.doc.mjs:10is1, as onmain). - No AppShell wrapper or AppShell metadata remains in the five showcases — verified (none at this head; the remaining metadata edits correct
componentsUsed). - The preview renderer, SideNav behavior and public API are unchanged — verified (only template files and a changeset change).
- The changeset describes only the footer addition — verified.
- The Overview preview shows the footer, and the four sibling previews keep their presentation — verified (before and after render of the block).
- The latest design review asked to keep only the footer, then approved it — verified.
- The template-doc typecheck, the four docsite suites, lint and formatting pass — verified at this head (179 docsite tests).
- Issue #2703 remains open — false (closed as completed on 2026-11-19).
- The pull request is design-approved and waits on maintainer CI — verified.
- Changeset: the SideNav showcase's footer now has support and settings destinations — verified (
- Files:
.changeset/fix-sidenav-showcase-bounds.md— clearSideNav/SideNavShowcase.tsx— clear (optional icon cleanup inline)SideNavCollapseButton/SideNavCollapseButtonShowcase.doc.mjs— clearSideNavHeading/SideNavHeadingShowcase.doc.mjs— clearSideNavHeading/SideNavHeadingShowcase.tsx— clearSideNavItem/SideNavItemShowcase.doc.mjs— clearSideNavSection/SideNavSectionShowcase.doc.mjs— clear
| 'use client'; | ||
|
|
||
| import type {ComponentProps} from 'react'; | ||
| import {HelpIcon, SettingsIcon} from '@astryxdesign/template-icons'; |
There was a problem hiding this comment.
Optional, non-blocking: HomeIcon, FolderIcon, ChartBarIcon and DocumentTextIcon below (lines 14-80) draw the same Heroicons the template icon table names HomeIcon, FolderIcon, ChartIcon and DocumentIcon. Importing them here removes the block's last inline SVG and about 65 lines, and brings the block under 100 lines:
import {
ChartIcon,
DocumentIcon,
FolderIcon,
HelpIcon,
HomeIcon,
SettingsIcon,
} from '@astryxdesign/template-icons';Analytics and All Documents then take icon={ChartIcon} and icon={DocumentIcon}.
There was a problem hiding this comment.
Approved pending CI: CI has not run on this head yet. Next step: a maintainer approves the waiting workflow runs (the ci:run label is already set) so CI runs.
The SideNav showcase now ends its rail with Help & docs and Settings in the footer, and the description now matches issue #2703's closed state, which resolves the earlier finding. An optional icon cleanup remains noted inline.
Claims and files checked
Review mode: same-head; reason: none
- Rules changed since the last review (0): none.
- Claims:
- Changeset: the SideNav showcase's footer now has support and settings destinations — verified (
SideNavShowcase.tsx:86-91). - The Support footer is kept only in the SideNav showcase, and the four sibling previews keep their standalone presentation — verified (the sibling sources render as on
main;SideNavHeadingShowcase.tsxonly reorders imports and adds a comment). - The Help and Settings icons come by meaning from the template icon package, as the other bundled templates' icons do, and the branch is merged with
main, which ships it — verified (SideNavShowcase.tsx:6; no page or block template imports an icon library directly; the package exports both icons at this head). - The showcase keeps its square aspect ratio — verified (
SideNavShowcase.doc.mjs:10is1, as onmain). - No AppShell wrapper or AppShell metadata remains in the five showcases — verified.
- The preview renderer, SideNav behavior and public API are unchanged — verified (only template files and a changeset change).
- The changeset describes only the footer addition — verified.
- The latest design review asked to keep only the footer, then approved it — verified.
- The template-doc typecheck, the four docsite suites, lint and formatting pass — verified at this head (the four suites hold 179 tests here).
- Issue #2703 was closed as completed on 2026-11-19 by a separate fix on
main, which this branch builds on — verified (the issue is closed as completed; the fix is in this branch's history). - The public text and artifacts hold no internal context — verified.
- Changeset: the SideNav showcase's footer now has support and settings destinations — verified (
- Files:
.changeset/fix-sidenav-showcase-bounds.md— clearSideNav/SideNavShowcase.tsx— clear (template rubric note and optional icon cleanup, non-blocking)SideNavCollapseButton/SideNavCollapseButtonShowcase.doc.mjs— clearSideNavHeading/SideNavHeadingShowcase.doc.mjs— clearSideNavHeading/SideNavHeadingShowcase.tsx— clearSideNavItem/SideNavItemShowcase.doc.mjs— clearSideNavSection/SideNavSectionShowcase.doc.mjs— clear
Primary intent
Narrow the SideNav showcase update to the design-approved footer change from the latest review.
User or maintainer impact
The main SideNav Overview preview now shows the complete navigation surface, including support and settings destinations in its footer. The four sibling previews keep their existing standalone presentation so they do not acquire an empty AppShell content area.
Authority
Change
SideNavShowcase.HelpIcon,SettingsIcon) from@astryxdesign/template-icons, as every bundled template does, instead of importing an icon library directly or duplicating SVG paths. The branch is merged withmain, which ships that package.aspectRatio, which matches the narrow SideNav presentation.Evidence
The earlier before/after attachments showed the superseded AppShell revision and have been removed from this description rather than presenting stale evidence. The current review target is intentionally small: the main SideNav preview has the added Support footer, while the four sibling previews remain their original standalone examples. The design reviewer can verify those two states directly in the generated preview.
Scope
Components: SideNav family showcase source and metadata, plus the CLI changeset.
Testing
pnpm -F @astryxdesign/cli typecheck:template-docs— passed.pnpm -F @astryxdesign/docsite exec vitest run src/__tests__/data-extraction.test.ts src/__tests__/example-coverage.test.ts src/__tests__/component-preview-state.test.ts src/__tests__/component-preview-theme.test.ts— 181 passed.Issue #2703 (the top-aligned Overview preview) was closed as completed on 2026-11-19 by a separate fix on
main. This PR builds on that fix: it adds the Help and Settings footer items to the SideNav showcase.